Frameworks/Adium Framework/AIContentObject.m

   1 /*
   2  * Adium is the legal property of its developers, whose names are listed in the copyright file included
   3  * with this source distribution.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
   6  * General Public License as published by the Free Software Foundation; either version 2 of the License,
   7  * or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  10  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
  11  * Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with this program; if not,
  14  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  15  */
  16
  17 #import "AIAccount.h"
  18 #import "AIChat.h"
  19 #import "AIContentController.h"
  20 #import "AIContentObject.h"
  21 #import "AIListObject.h"
  22 #import "AIHTMLDecoder.h"
  23
  24 @implementation AIContentObject
  25
  26 //
  27 - (id)initWithChat:(AIChat *)inChat
  28                         source:(AIListObject *)inSource
  29            destination:(AIListObject *)inDest
  30                           date:(NSDate*)inDate
  31 {
  32         return([self initWithChat:inChat source:inSource destination:inDest date:inDate message:nil]);
  33 }
  34 - (id)initWithChat:(AIChat *)inChat
  35                         source:(AIListObject *)inSource
  36            destination:(AIListObject *)inDest
  37                           date:(NSDate*)inDate
  38                    message:(NSAttributedString *)inMessage
  39 {
  40     if((self = [super init]))
  41         {
  42                 //Default Behavior
  43                 filterContent = YES;
  44                 trackContent = YES;
  45                 displayContent = YES;
  46                 displayContentImmediately = YES;
  47                 sendContent = YES;
  48                 postProcessContent = YES;
  49
  50                 //Store source, dest, chat, ...
  51                 source = [inSource retain];
  52                 destination = [inDest retain];
  53                 message = [inMessage retain];
  54                 date = [(inDate ? inDate : [NSDate date]) retain];
  55
  56                 chat = [inChat retain];
  57                 outgoing = ([source isKindOfClass:[AIAccount class]]);
  58                 userInfo = nil;
  59         }
  60
  61     return self;
  62 }
  63
  64 - (void)dealloc
  65 {
  66     [source release]; source = nil;
  67     [destination release]; destination = nil;
  68         [date release]; date = nil;
  69         [message release]; message = nil;
  70         [chat release]; chat = nil;
  71         [userInfo release]; userInfo = nil;
  72
  73     [super dealloc];
  74 }
  75
  76 //Content Identifier
  77 - (NSString *)type
  78 {
  79     return(@"");
  80 }
  81
  82 - (id)userInfo
  83 {
  84         return userInfo;
  85 }
  86
  87 - (void)setUserInfo:(id)inUserInfo
  88 {
  89         if(userInfo != inUserInfo){
  90                 [userInfo release];
  91                 userInfo = [inUserInfo retain];
  92         }
  93 }
  94
  95 //Comparing ------------------------------------------------------------------------------------------------------------
  96 #pragma mark Comparing
  97 //Content is similar if it's from the same source, of the same time, and sent within 5 minutes.
  98 - (BOOL)isSimilarToContent:(AIContentObject *)inContent
  99 {
 100         if(source == [inContent source] && [[self type] compare:[inContent type]] == 0){
 101                 NSTimeInterval  timeInterval = [date timeIntervalSinceDate:[inContent date]];
 102
 103                 return(timeInterval > -300 && timeInterval < 300);
 104         }
 105
 106         return(NO);
 107 }
 108
 109 //Content is from the same day. If passed nil, content is from the current day.
 110 - (BOOL)isFromSameDayAsContent:(AIContentObject *)inContent
 111 {
 112         NSCalendarDate *ourDate = [[self date] dateWithCalendarFormat:nil timeZone:nil];
 113         NSCalendarDate *inDate = [(inContent ? [inContent date] : [NSDate date]) dateWithCalendarFormat:nil timeZone:nil];
 114
 115         return([ourDate dayOfCommonEra] == [inDate dayOfCommonEra]);
 116 }
 117
 118 //Content --------------------------------------------------------------------------------------------------------------
 119 #pragma mark Content
 120 //Message Source and destination
 121 - (AIListObject *)source
 122 {
 123     return(source);
 124 }
 125 - (AIListObject *)destination
 126 {
 127     return(destination);
 128 }
 129
 130 //Date and time of this message
 131 - (NSDate *)date
 132 {
 133     return(date);
 134 }
 135
 136 //Is this content incoming or outgoing?
 137 - (BOOL)isOutgoing
 138 {
 139     return(outgoing);
 140 }
 141 - (void)_setIsOutgoing:(BOOL)inOutgoing
 142 { //Hack for message view preferences
 143         outgoing = inOutgoing;
 144 }
 145
 146 //Chat containing this content
 147 - (void)setChat:(AIChat *)inChat
 148 {
 149     chat = inChat;
 150 }
 151 - (AIChat *)chat
 152 {
 153     return(chat);
 154 }
 155
 156 //Attributed Message
 157 - (void)setMessage:(NSAttributedString *)inMessage
 158 {
 159         if(message != inMessage){
 160                 [message release];
 161                 message = [inMessage retain];
 162         }
 163 }
 164 - (NSAttributedString *)message
 165 {
 166         return(message);
 167 }
 168
 169 //HTML string message
 170 - (void)setMessageHTML:(NSString *)inMessageString
 171 {
 172         [message release];
 173         message = [[AIHTMLDecoder decodeHTML:inMessageString] retain];
 174 }
 175 - (NSString *)messageHTML
 176 {
 177         return [AIHTMLDecoder encodeHTML:message encodeFullString:YES];
 178 }
 179
 180 //Plaintext string message
 181 - (void)setMessageString:(NSString *)inMessageString
 182 {
 183         [message release];
 184         message = [[NSAttributedString alloc] initWithString:inMessageString
 185                                                                                           attributes:[[adium contentController] defaultFormattingAttributes]];
 186
 187 }
 188 - (NSString *)messageString
 189 {
 190         return [message string];
 191 }
 192
 193
 194 //Behavior -------------------------------------------------------------------------------------------------------------
 195 #pragma mark Behavior
 196 /*
 197  * @brief Set if this content is passed through content filters
 198  */
 199 - (void)setFilterContent:(BOOL)inFilterContent
 200 {
 201         filterContent = inFilterContent;
 202 }
 203 /*
 204  * @brief Is this content passed through content filters?
 205  */
 206 - (BOOL)filterContent
 207 {
 208     return filterContent;
 209 }
 210
 211 /*
 212  * @brief Set if this content is tracked
 213  */
 214 - (void)setTrackContent:(BOOL)inTrackContent
 215 {
 216         trackContent = inTrackContent;
 217 }
 218 /*
 219  * @brief Is this content tracked with notifications?
 220  *
 221  * If NO, the content will not trigger message sent/message received events such as a sound playing.
 222  */
 223 - (BOOL)trackContent
 224 {
 225     return trackContent;
 226 }
 227
 228 /*
 229  * @brief Set if this content is displayed
 230  */
 231 - (void)setDisplayContent:(BOOL)inDisplayContent
 232 {
 233         displayContent = inDisplayContent;
 234 }
 235 /*
 236  * @brief Is this content displayed?
 237  *
 238  * This will be NO for a content object such as an AIContentTyping object which is sent but not displayed
 239  */
 240 - (BOOL)displayContent
 241 {
 242     return displayContent;
 243 }
 244
 245 /*
 246  * @brief Set if this content is displayed immediately
 247  */
 248 - (void)setDisplayContentImmediately:(BOOL)inDisplayContentImmediately
 249 {
 250         displayContentImmediately = inDisplayContentImmediately;
 251 }
 252 /*
 253  * @brief Should this content be displayed immediately?
 254  *
 255  * If NO, the object which created this content is responsible for posting Content_ChatDidFinishAddingUntrackedContent
 256  * with an object of the associated AIChat to [adium notificationCenter] at some point in the future to request display.
 257  */
 258 - (BOOL)displayContentImmediately
 259 {
 260         return displayContentImmediately;
 261 }
 262
 263 /*
 264  * @brief Set if the content should be sent
 265  */
 266 - (void)setSendContent:(BOOL)inSendContent{
 267         sendContent = inSendContent;
 268 }
 269 /*
 270  * @brief Send the content?
 271  */
 272 - (BOOL)sendContent{
 273         return sendContent;
 274 }
 275
 276 /*
 277  * @brief Set if this content is post processed
 278  */
 279 - (void)setPostProcessContent:(BOOL)inPostProcessContent
 280 {
 281         postProcessContent = inPostProcessContent;
 282 }
 283 /*
 284  * @brief Post process this content?
 285  *
 286  * For example, this should be YES if the content is to be logged and NO if it is not.
 287  */
 288 - (BOOL)postProcessContent
 289 {
 290         return postProcessContent;
 291 }
 292
 293 @end